Show:

Streams inplace Class

Uses
Defined in: platform/plugins/Streams/handlers/Streams/inplace/tool.php:7
Module: Streams-tools

This tool generates an inline editor to edit the content or attribute of a stream.

Constructor

Streams inplace

(
  • $options
)

Defined in platform/plugins/Streams/handlers/Streams/inplace/tool.php:7

Parameters:

  • $options Array

    Options for the tool An associative array of parameters, containing:

    • [inplaceType='textarea'] String optional

      The type of the fieldInput. Can be "textarea" or "text"

    • [convert] Array optional

      The characters to convert to HTML. Pass an array containing zero or more of "\n", " "

    • stream Streams_Stream

      A Streams_Stream object

    • [field] String optional

      Optional, name of an field to change instead of the content of the stream

    • [attribute] String optional

      Optional, name of an attribute to change instead of any field.

    • [beforeSave] String optional

      Reference to a callback to call after a successful save. This callback can cancel the save by returning false.

    • [inplace=array()] Array optional

      Additional fields to pass to the child Q/inplace tool, if any

Item Index